<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="UTF-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
	<title>Scroll API | ElasticSearch 7.7 权威指南中文版</title>
	<meta name="keywords" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <meta name="description" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <!-- Give IE8 a fighting chance -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
	<link rel="stylesheet" type="text/css" href="../static/styles.css" />
	<script>
	var _link = 'scroll-api.html';
    </script>
</head>
<body>
<div class="main-container">
    <section id="content">
        <div class="content-wrapper">
            <section id="guide" lang="zh_cn">
                <div class="container">
                    <div class="row">
                        <div class="col-xs-12 col-sm-8 col-md-8 guide-section">
                            <div style="color:gray; word-break: break-all; font-size:12px;">原英文版地址: <a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.7/scroll-api.html" rel="nofollow" target="_blank">https://www.elastic.co/guide/en/elasticsearch/reference/7.7/scroll-api.html</a>, 原文档版权归 www.elastic.co 所有<br/>本地英文版地址: <a href="../en/scroll-api.html" rel="nofollow" target="_blank">../en/scroll-api.html</a></div>
                        <!-- start body -->
                  <div class="page_header">
<strong>重要</strong>: 此版本不会发布额外的bug修复或文档更新。最新信息请参考 <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html" rel="nofollow">当前版本文档</a>。
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="index.html">Elasticsearch Guide [7.7]</a></span>
»
<span class="breadcrumb-link"><a href="rest-apis.html">REST APIs</a></span>
»
<span class="breadcrumb-link"><a href="search.html">Search APIs</a></span>
»
<span class="breadcrumb-node">Scroll API</span>
</div>
<div class="navheader">
<span class="prev">
<a href="async-search.html">« Async search</a>
</span>
<span class="next">
<a href="clear-scroll-api.html">Clear scroll API »</a>
</span>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h2 class="title">
<a id="scroll-api"></a>Scroll API<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/search/scroll-api.asciidoc">edit</a>
</h2>
</div></div></div>

<p>Retrieves the next batch of results for a <a class="xref" href="search-request-body.html#request-body-search-scroll" title="Scroll">scrolling
search</a>.</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">GET /_search/scroll
{
    "scroll_id" : "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ=="
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/1983.console"></div>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="scroll-api-request"></a>Request<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/search/scroll-api.asciidoc">edit</a>
</h3>
</div></div></div>
<p><code class="literal">GET /_search/scroll/&lt;scroll_id&gt;</code>
<span class="Admonishment Admonishment--change">
[<span class="Admonishment-version u-mono u-strikethrough">7.0.0</span>]
<span class="Admonishment-detail">
Deprecated in 7.0.0.
</span>
</span></p>
<p><code class="literal">GET /_search/scroll</code></p>
<p><code class="literal">POST /_search/scroll/&lt;scroll_id&gt;</code>
<span class="Admonishment Admonishment--change">
[<span class="Admonishment-version u-mono u-strikethrough">7.0.0</span>]
<span class="Admonishment-detail">
Deprecated in 7.0.0.
</span>
</span></p>
<p><code class="literal">POST /_search/scroll</code></p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="scroll-api-desc"></a>Description<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/search/scroll-api.asciidoc">edit</a>
</h3>
</div></div></div>
<p>You can use the scroll API to retrieve large sets of results from a single
<a class="xref" href="search-request-body.html#request-body-search-scroll" title="Scroll">scrolling search</a> request.</p>
<p>The scroll API requires a scroll ID. To get a scroll ID, submit a
<a class="xref" href="search-search.html" title="Search API">search API</a> request that includes an argument for the
<a class="xref" href="search-search.html#search-api-scroll-query-param"><code class="literal">scroll</code> query parameter</a>. The <code class="literal">scroll</code>
parameter indicates how long Elasticsearch should retain the
<a class="xref" href="search-request-body.html#scroll-search-context" title="Keeping the search context alive">search context</a> for the request.</p>
<p>The search response returns a scroll ID in the <code class="literal">_scroll_id</code> response body
parameter. You can then use the scroll ID with the scroll API to retrieve the
next batch of results for the request.</p>
<p>You can also use the scroll API to specify a new <code class="literal">scroll</code> parameter that extends
or shortens the retention period for the search context.</p>
<p>See <a class="xref" href="search-request-body.html#request-body-search-scroll" title="Scroll">Scroll</a>.</p>
<div class="important admon">
<div class="icon"></div>
<div class="admon_content">
<p>Results from a scrolling search reflect the state of the index at the
time of the initial search request. Subsequent indexing or document changes only
affect later search and scroll requests.</p>
</div>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="scroll-api-path-params"></a>Path parameters<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/search/scroll-api.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">&lt;scroll_id&gt;</code>
</span>
</dt>
<dd>
<p>
<span class="Admonishment Admonishment--change">
[<span class="Admonishment-version u-mono u-strikethrough">7.0.0</span>]
<span class="Admonishment-detail">
Deprecated in 7.0.0.
</span>
</span>
(Optional, string)
Scroll ID of the search.
</p>
<div class="important admon">
<div class="icon"></div>
<div class="admon_content">
<p>Scroll IDs can be long. We recommend only specifying scroll IDs using
the <a class="xref" href="scroll-api.html#scroll-api-scroll-id-param"><code class="literal">scroll_id</code> request body parameter</a>.</p>
</div>
</div>
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="scroll-api-query-params"></a>Query parameters<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/search/scroll-api.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">scroll</code>
</span>
</dt>
<dd>
<p>
(Optional, <a class="xref" href="common-options.html#time-units" title="Time units">time value</a>)
Period to retain the <a class="xref" href="search-request-body.html#scroll-search-context" title="Keeping the search context alive">search context</a> for scrolling. See
<a class="xref" href="search-request-body.html#request-body-search-scroll" title="Scroll">Scroll</a>.
</p>
<p>This value overrides the duration set by the original search API request’s
<code class="literal">scroll</code> parameter.</p>
<p>By default, this value cannot must be less than <code class="literal">1d</code> (one day). You can change
this limit using the <code class="literal">search.max_keep_alive</code> cluster-level setting.</p>
<div class="important admon">
<div class="icon"></div>
<div class="admon_content">
<p>You can also specify this value using the <code class="literal">scroll</code> request body
parameter. If both parameters are specified, only the query parameter is used.</p>
</div>
</div>
</dd>
<dt>
<span class="term">
<code class="literal">scroll_id</code>
</span>
</dt>
<dd>
<p>
<span class="Admonishment Admonishment--change">
[<span class="Admonishment-version u-mono u-strikethrough">7.0.0</span>]
<span class="Admonishment-detail">
Deprecated in 7.0.0.
</span>
</span>
(Optional, string)
Scroll ID for the search.
</p>
<div class="important admon">
<div class="icon"></div>
<div class="admon_content">
<p>Scroll IDs can be long. We recommend only specifying scroll IDs using
the <a class="xref" href="scroll-api.html#scroll-api-scroll-id-param"><code class="literal">scroll_id</code> request body parameter</a>.</p>
</div>
</div>
</dd>
<dt>
<span class="term">
<code class="literal">rest_total_hits_as_int</code>
</span>
</dt>
<dd>
(Optional, boolean)
If <code class="literal">true</code>, the API response’s <code class="literal">hit.total</code> property is returned as an integer.
If <code class="literal">false</code>, the API response’s <code class="literal">hit.total</code> property is returned as an object.
Defaults to <code class="literal">false</code>.
</dd>
</dl>
</div>
</div>

<div class="section child_attributes">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="scroll-api-request-body"></a>Request body<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/search/scroll-api.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">scroll</code>
</span>
</dt>
<dd>
<p>
(Optional, <a class="xref" href="common-options.html#time-units" title="Time units">time value</a>)
Period to retain the <a class="xref" href="search-request-body.html#scroll-search-context" title="Keeping the search context alive">search context</a> for scrolling. See
<a class="xref" href="search-request-body.html#request-body-search-scroll" title="Scroll">Scroll</a>.
</p>
<p>This value overrides the duration set by the original search API request’s
<code class="literal">scroll</code> parameter.</p>
<p>By default, this value cannot exceed <code class="literal">1d</code> (24 hours). You can change
this limit using the <code class="literal">search.max_keep_alive</code> cluster-level setting.</p>
<div class="important admon">
<div class="icon"></div>
<div class="admon_content">
<p>You can also specify this value using the <code class="literal">scroll</code> query
parameter. If both parameters are specified, only the query parameter is used.</p>
</div>
</div>
</dd>
</dl>
</div>
<div class="variablelist">
<a id="scroll-api-scroll-id-param"></a>
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">scroll_id</code>
</span>
</dt>
<dd>
(Required, string)
Scroll ID for the search.
</dd>
</dl>
</div>
</div>

<div class="section child_attributes">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="scroll-api-response-body"></a>Response body<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/search/scroll-api.asciidoc">edit</a>
</h3>
</div></div></div>
<p>The scroll API returns the same response body as the search API. See the search
API’s <a class="xref" href="search-search.html#search-api-response-body" title="Response body">response body parameters</a>.</p>
</div>

</div>
<div class="navfooter">
<span class="prev">
<a href="async-search.html">« Async search</a>
</span>
<span class="next">
<a href="clear-scroll-api.html">Clear scroll API »</a>
</span>
</div>
</div>

                  <!-- end body -->
                        </div>
                        <div class="col-xs-12 col-sm-4 col-md-4" id="right_col">
                        
                        </div>
                    </div>
                </div>
            </section>
        </div>
    </section>
</div>
<script src="../static/cn.js"></script>
</body>
</html>